Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Refactor Stroke API and add MediaContainerNode.replaceMedia() API #88

Merged
merged 8 commits into from
Sep 10, 2024
Merged

Refactor Stroke API and add MediaContainerNode.replaceMedia() API #88

merged 8 commits into from
Sep 10, 2024

Conversation

xerxovksi
Copy link
Collaborator

@xerxovksi xerxovksi commented Sep 9, 2024 •
edited
Loading

Description

Changes

  • Refactor Stroke API
  • Add MediaContainerNode.replaceMedia()

Additional changes

  • The TypeDoc package is used to generate the docs.
  • It has been upgraded from version 0.23.15 to 0.25.13 for compatibility with TypeScript 5.4.5.
  • Given this change, the structure of the docs are slightly modified.

Related Issue

Motivation and Context

How Has This Been Tested?

Screenshots (if appropriate):

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)

Checklist:

  • I have signed the Adobe Open Source CLA.
  • My code follows the code style of this project.
  • My change requires a change to the documentation.
  • I have updated the documentation accordingly.
  • I have read the CONTRIBUTING document.
  • I have added tests to cover my changes.
  • All new and existing tests passed.

hollyschinsky
hollyschinsky requested changes Sep 9, 2024
View reviewed changes
Copy link
Collaborator

@hollyschinsky hollyschinsky left a comment •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@xerxovksi I noticed the names of the signatures are all shifted over to the right compared to our prod docs.

ss13

vs on prod

ss13

Looks like maybe the little char that was there is gone too, but moreso the extra space should at least get removed I guess. Must be something in how they got converted since I see it in all of the doc API refs :/

@xerxovksi
Copy link
Collaborator Author

@xerxovksi I noticed the names of the signatures are all shifted over to the right compared to our prod docs.

ss13 vs on prod ss13 Looks like maybe the little char that was there is gone too, but moreso the extra space should at least get removed I guess. Must be something in how they got converted since I see it in all of the doc API refs :/

Yes, this is generated. I have removed the indentation now and added it to the manual steps in the README.

@hollyschinsky
Copy link
Collaborator

Added entry to changelog and merging.

@hollyschinsky hollyschinsky merged commit 1a742c4 into main Sep 10, 2024
4 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@vamshich13 vamshich13 Awaiting requested review from vamshich13

@hollyschinsky hollyschinsky Awaiting requested review from hollyschinsky

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@xerxovksi @hollyschinsky